home *** CD-ROM | disk | FTP | other *** search
/ Freelog 100 / FreelogNo100-NovembreDecembre2010.iso / Musique / solfege / solfege-win32-3.17.0.exe / {app} / bin / Lib / optparse.py < prev    next >
Text File  |  2008-12-13  |  62KB  |  1,692 lines
  1. """A powerful, extensible, and easy-to-use option parser.
  2.  
  3. By Greg Ward <gward@python.net>
  4.  
  5. Originally distributed as Optik.
  6.  
  7. For support, use the optik-users@lists.sourceforge.net mailing list
  8. (http://lists.sourceforge.net/lists/listinfo/optik-users).
  9. """
  10.  
  11. __version__ = "1.5.3"
  12.  
  13. __all__ = ['Option',
  14.            'SUPPRESS_HELP',
  15.            'SUPPRESS_USAGE',
  16.            'Values',
  17.            'OptionContainer',
  18.            'OptionGroup',
  19.            'OptionParser',
  20.            'HelpFormatter',
  21.            'IndentedHelpFormatter',
  22.            'TitledHelpFormatter',
  23.            'OptParseError',
  24.            'OptionError',
  25.            'OptionConflictError',
  26.            'OptionValueError',
  27.            'BadOptionError']
  28.  
  29. __copyright__ = """
  30. Copyright (c) 2001-2006 Gregory P. Ward.  All rights reserved.
  31. Copyright (c) 2002-2006 Python Software Foundation.  All rights reserved.
  32.  
  33. Redistribution and use in source and binary forms, with or without
  34. modification, are permitted provided that the following conditions are
  35. met:
  36.  
  37.   * Redistributions of source code must retain the above copyright
  38.     notice, this list of conditions and the following disclaimer.
  39.  
  40.   * Redistributions in binary form must reproduce the above copyright
  41.     notice, this list of conditions and the following disclaimer in the
  42.     documentation and/or other materials provided with the distribution.
  43.  
  44.   * Neither the name of the author nor the names of its
  45.     contributors may be used to endorse or promote products derived from
  46.     this software without specific prior written permission.
  47.  
  48. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  49. IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  50. TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  51. PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR
  52. CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  53. EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  54. PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  55. PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  56. LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  57. NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  58. SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  59. """
  60.  
  61. import sys, os
  62. import types
  63. import textwrap
  64.  
  65. def _repr(self):
  66.     return "<%s at 0x%x: %s>" % (self.__class__.__name__, id(self), self)
  67.  
  68.  
  69. # This file was generated from:
  70. #   Id: option_parser.py 527 2006-07-23 15:21:30Z greg
  71. #   Id: option.py 522 2006-06-11 16:22:03Z gward
  72. #   Id: help.py 527 2006-07-23 15:21:30Z greg
  73. #   Id: errors.py 509 2006-04-20 00:58:24Z gward
  74.  
  75. try:
  76.     from gettext import gettext
  77. except ImportError:
  78.     def gettext(message):
  79.         return message
  80. _ = gettext
  81.  
  82.  
  83. class OptParseError (Exception):
  84.     def __init__(self, msg):
  85.         self.msg = msg
  86.  
  87.     def __str__(self):
  88.         return self.msg
  89.  
  90.  
  91. class OptionError (OptParseError):
  92.     """
  93.     Raised if an Option instance is created with invalid or
  94.     inconsistent arguments.
  95.     """
  96.  
  97.     def __init__(self, msg, option):
  98.         self.msg = msg
  99.         self.option_id = str(option)
  100.  
  101.     def __str__(self):
  102.         if self.option_id:
  103.             return "option %s: %s" % (self.option_id, self.msg)
  104.         else:
  105.             return self.msg
  106.  
  107. class OptionConflictError (OptionError):
  108.     """
  109.     Raised if conflicting options are added to an OptionParser.
  110.     """
  111.  
  112. class OptionValueError (OptParseError):
  113.     """
  114.     Raised if an invalid option value is encountered on the command
  115.     line.
  116.     """
  117.  
  118. class BadOptionError (OptParseError):
  119.     """
  120.     Raised if an invalid option is seen on the command line.
  121.     """
  122.     def __init__(self, opt_str):
  123.         self.opt_str = opt_str
  124.  
  125.     def __str__(self):
  126.         return _("no such option: %s") % self.opt_str
  127.  
  128. class AmbiguousOptionError (BadOptionError):
  129.     """
  130.     Raised if an ambiguous option is seen on the command line.
  131.     """
  132.     def __init__(self, opt_str, possibilities):
  133.         BadOptionError.__init__(self, opt_str)
  134.         self.possibilities = possibilities
  135.  
  136.     def __str__(self):
  137.         return (_("ambiguous option: %s (%s?)")
  138.                 % (self.opt_str, ", ".join(self.possibilities)))
  139.  
  140.  
  141. class HelpFormatter:
  142.  
  143.     """
  144.     Abstract base class for formatting option help.  OptionParser
  145.     instances should use one of the HelpFormatter subclasses for
  146.     formatting help; by default IndentedHelpFormatter is used.
  147.  
  148.     Instance attributes:
  149.       parser : OptionParser
  150.         the controlling OptionParser instance
  151.       indent_increment : int
  152.         the number of columns to indent per nesting level
  153.       max_help_position : int
  154.         the maximum starting column for option help text
  155.       help_position : int
  156.         the calculated starting column for option help text;
  157.         initially the same as the maximum
  158.       width : int
  159.         total number of columns for output (pass None to constructor for
  160.         this value to be taken from the $COLUMNS environment variable)
  161.       level : int
  162.         current indentation level
  163.       current_indent : int
  164.         current indentation level (in columns)
  165.       help_width : int
  166.         number of columns available for option help text (calculated)
  167.       default_tag : str
  168.         text to replace with each option's default value, "%default"
  169.         by default.  Set to false value to disable default value expansion.
  170.       option_strings : { Option : str }
  171.         maps Option instances to the snippet of help text explaining
  172.         the syntax of that option, e.g. "-h, --help" or
  173.         "-fFILE, --file=FILE"
  174.       _short_opt_fmt : str
  175.         format string controlling how short options with values are
  176.         printed in help text.  Must be either "%s%s" ("-fFILE") or
  177.         "%s %s" ("-f FILE"), because those are the two syntaxes that
  178.         Optik supports.
  179.       _long_opt_fmt : str
  180.         similar but for long options; must be either "%s %s" ("--file FILE")
  181.         or "%s=%s" ("--file=FILE").
  182.     """
  183.  
  184.     NO_DEFAULT_VALUE = "none"
  185.  
  186.     def __init__(self,
  187.                  indent_increment,
  188.                  max_help_position,
  189.                  width,
  190.                  short_first):
  191.         self.parser = None
  192.         self.indent_increment = indent_increment
  193.         self.help_position = self.max_help_position = max_help_position
  194.         if width is None:
  195.             try:
  196.                 width = int(os.environ['COLUMNS'])
  197.             except (KeyError, ValueError):
  198.                 width = 80
  199.             width -= 2
  200.         self.width = width
  201.         self.current_indent = 0
  202.         self.level = 0
  203.         self.help_width = None          # computed later
  204.         self.short_first = short_first
  205.         self.default_tag = "%default"
  206.         self.option_strings = {}
  207.         self._short_opt_fmt = "%s %s"
  208.         self._long_opt_fmt = "%s=%s"
  209.  
  210.     def set_parser(self, parser):
  211.         self.parser = parser
  212.  
  213.     def set_short_opt_delimiter(self, delim):
  214.         if delim not in ("", " "):
  215.             raise ValueError(
  216.                 "invalid metavar delimiter for short options: %r" % delim)
  217.         self._short_opt_fmt = "%s" + delim + "%s"
  218.  
  219.     def set_long_opt_delimiter(self, delim):
  220.         if delim not in ("=", " "):
  221.             raise ValueError(
  222.                 "invalid metavar delimiter for long options: %r" % delim)
  223.         self._long_opt_fmt = "%s" + delim + "%s"
  224.  
  225.     def indent(self):
  226.         self.current_indent += self.indent_increment
  227.         self.level += 1
  228.  
  229.     def dedent(self):
  230.         self.current_indent -= self.indent_increment
  231.         assert self.current_indent >= 0, "Indent decreased below 0."
  232.         self.level -= 1
  233.  
  234.     def format_usage(self, usage):
  235.         raise NotImplementedError, "subclasses must implement"
  236.  
  237.     def format_heading(self, heading):
  238.         raise NotImplementedError, "subclasses must implement"
  239.  
  240.     def _format_text(self, text):
  241.         """
  242.         Format a paragraph of free-form text for inclusion in the
  243.         help output at the current indentation level.
  244.         """
  245.         text_width = self.width - self.current_indent
  246.         indent = " "*self.current_indent
  247.         return textwrap.fill(text,
  248.                              text_width,
  249.                              initial_indent=indent,
  250.                              subsequent_indent=indent)
  251.  
  252.     def format_description(self, description):
  253.         if description:
  254.             return self._format_text(description) + "\n"
  255.         else:
  256.             return ""
  257.  
  258.     def format_epilog(self, epilog):
  259.         if epilog:
  260.             return "\n" + self._format_text(epilog) + "\n"
  261.         else:
  262.             return ""
  263.  
  264.  
  265.     def expand_default(self, option):
  266.         if self.parser is None or not self.default_tag:
  267.             return option.help
  268.  
  269.         default_value = self.parser.defaults.get(option.dest)
  270.         if default_value is NO_DEFAULT or default_value is None:
  271.             default_value = self.NO_DEFAULT_VALUE
  272.  
  273.         return option.help.replace(self.default_tag, str(default_value))
  274.  
  275.     def format_option(self, option):
  276.         # The help for each option consists of two parts:
  277.         #   * the opt strings and metavars
  278.         #     eg. ("-x", or "-fFILENAME, --file=FILENAME")
  279.         #   * the user-supplied help string
  280.         #     eg. ("turn on expert mode", "read data from FILENAME")
  281.         #
  282.         # If possible, we write both of these on the same line:
  283.         #   -x      turn on expert mode
  284.         #
  285.         # But if the opt string list is too long, we put the help
  286.         # string on a second line, indented to the same column it would
  287.         # start in if it fit on the first line.
  288.         #   -fFILENAME, --file=FILENAME
  289.         #           read data from FILENAME
  290.         result = []
  291.         opts = self.option_strings[option]
  292.         opt_width = self.help_position - self.current_indent - 2
  293.         if len(opts) > opt_width:
  294.             opts = "%*s%s\n" % (self.current_indent, "", opts)
  295.             indent_first = self.help_position
  296.         else:                       # start help on same line as opts
  297.             opts = "%*s%-*s  " % (self.current_indent, "", opt_width, opts)
  298.             indent_first = 0
  299.         result.append(opts)
  300.         if option.help:
  301.             help_text = self.expand_default(option)
  302.             help_lines = textwrap.wrap(help_text, self.help_width)
  303.             result.append("%*s%s\n" % (indent_first, "", help_lines[0]))
  304.             result.extend(["%*s%s\n" % (self.help_position, "", line)
  305.                            for line in help_lines[1:]])
  306.         elif opts[-1] != "\n":
  307.             result.append("\n")
  308.         return "".join(result)
  309.  
  310.     def store_option_strings(self, parser):
  311.         self.indent()
  312.         max_len = 0
  313.         for opt in parser.option_list:
  314.             strings = self.format_option_strings(opt)
  315.             self.option_strings[opt] = strings
  316.             max_len = max(max_len, len(strings) + self.current_indent)
  317.         self.indent()
  318.         for group in parser.option_groups:
  319.             for opt in group.option_list:
  320.                 strings = self.format_option_strings(opt)
  321.                 self.option_strings[opt] = strings
  322.                 max_len = max(max_len, len(strings) + self.current_indent)
  323.         self.dedent()
  324.         self.dedent()
  325.         self.help_position = min(max_len + 2, self.max_help_position)
  326.         self.help_width = self.width - self.help_position
  327.  
  328.     def format_option_strings(self, option):
  329.         """Return a comma-separated list of option strings & metavariables."""
  330.         if option.takes_value():
  331.             metavar = option.metavar or option.dest.upper()
  332.             short_opts = [self._short_opt_fmt % (sopt, metavar)
  333.                           for sopt in option._short_opts]
  334.             long_opts = [self._long_opt_fmt % (lopt, metavar)
  335.                          for lopt in option._long_opts]
  336.         else:
  337.             short_opts = option._short_opts
  338.             long_opts = option._long_opts
  339.  
  340.         if self.short_first:
  341.             opts = short_opts + long_opts
  342.         else:
  343.             opts = long_opts + short_opts
  344.  
  345.         return ", ".join(opts)
  346.  
  347. class IndentedHelpFormatter (HelpFormatter):
  348.     """Format help with indented section bodies.
  349.     """
  350.  
  351.     def __init__(self,
  352.                  indent_increment=2,
  353.                  max_help_position=24,
  354.                  width=None,
  355.                  short_first=1):
  356.         HelpFormatter.__init__(
  357.             self, indent_increment, max_help_position, width, short_first)
  358.  
  359.     def format_usage(self, usage):
  360.         return _("Usage: %s\n") % usage
  361.  
  362.     def format_heading(self, heading):
  363.         return "%*s%s:\n" % (self.current_indent, "", heading)
  364.  
  365.  
  366. class TitledHelpFormatter (HelpFormatter):
  367.     """Format help with underlined section headers.
  368.     """
  369.  
  370.     def __init__(self,
  371.                  indent_increment=0,
  372.                  max_help_position=24,
  373.                  width=None,
  374.                  short_first=0):
  375.         HelpFormatter.__init__ (
  376.             self, indent_increment, max_help_position, width, short_first)
  377.  
  378.     def format_usage(self, usage):
  379.         return "%s  %s\n" % (self.format_heading(_("Usage")), usage)
  380.  
  381.     def format_heading(self, heading):
  382.         return "%s\n%s\n" % (heading, "=-"[self.level] * len(heading))
  383.  
  384.  
  385. def _parse_num(val, type):
  386.     if val[:2].lower() == "0x":         # hexadecimal
  387.         radix = 16
  388.     elif val[:2].lower() == "0b":       # binary
  389.         radix = 2
  390.         val = val[2:] or "0"            # have to remove "0b" prefix
  391.     elif val[:1] == "0":                # octal
  392.         radix = 8
  393.     else:                               # decimal
  394.         radix = 10
  395.  
  396.     return type(val, radix)
  397.  
  398. def _parse_int(val):
  399.     return _parse_num(val, int)
  400.  
  401. def _parse_long(val):
  402.     return _parse_num(val, long)
  403.  
  404. _builtin_cvt = { "int" : (_parse_int, _("integer")),
  405.                  "long" : (_parse_long, _("long integer")),
  406.                  "float" : (float, _("floating-point")),
  407.                  "complex" : (complex, _("complex")) }
  408.  
  409. def check_builtin(option, opt, value):
  410.     (cvt, what) = _builtin_cvt[option.type]
  411.     try:
  412.         return cvt(value)
  413.     except ValueError:
  414.         raise OptionValueError(
  415.             _("option %s: invalid %s value: %r") % (opt, what, value))
  416.  
  417. def check_choice(option, opt, value):
  418.     if value in option.choices:
  419.         return value
  420.     else:
  421.         choices = ", ".join(map(repr, option.choices))
  422.         raise OptionValueError(
  423.             _("option %s: invalid choice: %r (choose from %s)")
  424.             % (opt, value, choices))
  425.  
  426. # Not supplying a default is different from a default of None,
  427. # so we need an explicit "not supplied" value.
  428. NO_DEFAULT = ("NO", "DEFAULT")
  429.  
  430.  
  431. class Option:
  432.     """
  433.     Instance attributes:
  434.       _short_opts : [string]
  435.       _long_opts : [string]
  436.  
  437.       action : string
  438.       type : string
  439.       dest : string
  440.       default : any
  441.       nargs : int
  442.       const : any
  443.       choices : [string]
  444.       callback : function
  445.       callback_args : (any*)
  446.       callback_kwargs : { string : any }
  447.       help : string
  448.       metavar : string
  449.     """
  450.  
  451.     # The list of instance attributes that may be set through
  452.     # keyword args to the constructor.
  453.     ATTRS = ['action',
  454.              'type',
  455.              'dest',
  456.              'default',
  457.              'nargs',
  458.              'const',
  459.              'choices',
  460.              'callback',
  461.              'callback_args',
  462.              'callback_kwargs',
  463.              'help',
  464.              'metavar']
  465.  
  466.     # The set of actions allowed by option parsers.  Explicitly listed
  467.     # here so the constructor can validate its arguments.
  468.     ACTIONS = ("store",
  469.                "store_const",
  470.                "store_true",
  471.                "store_false",
  472.                "append",
  473.                "append_const",
  474.                "count",
  475.                "callback",
  476.                "help",
  477.                "version")
  478.  
  479.     # The set of actions that involve storing a value somewhere;
  480.     # also listed just for constructor argument validation.  (If
  481.     # the action is one of these, there must be a destination.)
  482.     STORE_ACTIONS = ("store",
  483.                      "store_const",
  484.                      "store_true",
  485.                      "store_false",
  486.                      "append",
  487.                      "append_const",
  488.                      "count")
  489.  
  490.     # The set of actions for which it makes sense to supply a value
  491.     # type, ie. which may consume an argument from the command line.
  492.     TYPED_ACTIONS = ("store",
  493.                      "append",
  494.                      "callback")
  495.  
  496.     # The set of actions which *require* a value type, ie. that
  497.     # always consume an argument from the command line.
  498.     ALWAYS_TYPED_ACTIONS = ("store",
  499.                             "append")
  500.  
  501.     # The set of actions which take a 'const' attribute.
  502.     CONST_ACTIONS = ("store_const",
  503.                      "append_const")
  504.  
  505.     # The set of known types for option parsers.  Again, listed here for
  506.     # constructor argument validation.
  507.     TYPES = ("string", "int", "long", "float", "complex", "choice")
  508.  
  509.     # Dictionary of argument checking functions, which convert and
  510.     # validate option arguments according to the option type.
  511.     #
  512.     # Signature of checking functions is:
  513.     #   check(option : Option, opt : string, value : string) -> any
  514.     # where
  515.     #   option is the Option instance calling the checker
  516.     #   opt is the actual option seen on the command-line
  517.     #     (eg. "-a", "--file")
  518.     #   value is the option argument seen on the command-line
  519.     #
  520.     # The return value should be in the appropriate Python type
  521.     # for option.type -- eg. an integer if option.type == "int".
  522.     #
  523.     # If no checker is defined for a type, arguments will be
  524.     # unchecked and remain strings.
  525.     TYPE_CHECKER = { "int"    : check_builtin,
  526.                      "long"   : check_builtin,
  527.                      "float"  : check_builtin,
  528.                      "complex": check_builtin,
  529.                      "choice" : check_choice,
  530.                    }
  531.  
  532.  
  533.     # CHECK_METHODS is a list of unbound method objects; they are called
  534.     # by the constructor, in order, after all attributes are
  535.     # initialized.  The list is created and filled in later, after all
  536.     # the methods are actually defined.  (I just put it here because I
  537.     # like to define and document all class attributes in the same
  538.     # place.)  Subclasses that add another _check_*() method should
  539.     # define their own CHECK_METHODS list that adds their check method
  540.     # to those from this class.
  541.     CHECK_METHODS = None
  542.  
  543.  
  544.     # -- Constructor/initialization methods ----------------------------
  545.  
  546.     def __init__(self, *opts, **attrs):
  547.         # Set _short_opts, _long_opts attrs from 'opts' tuple.
  548.         # Have to be set now, in case no option strings are supplied.
  549.         self._short_opts = []
  550.         self._long_opts = []
  551.         opts = self._check_opt_strings(opts)
  552.         self._set_opt_strings(opts)
  553.  
  554.         # Set all other attrs (action, type, etc.) from 'attrs' dict
  555.         self._set_attrs(attrs)
  556.  
  557.         # Check all the attributes we just set.  There are lots of
  558.         # complicated interdependencies, but luckily they can be farmed
  559.         # out to the _check_*() methods listed in CHECK_METHODS -- which
  560.         # could be handy for subclasses!  The one thing these all share
  561.         # is that they raise OptionError if they discover a problem.
  562.         for checker in self.CHECK_METHODS:
  563.             checker(self)
  564.  
  565.     def _check_opt_strings(self, opts):
  566.         # Filter out None because early versions of Optik had exactly
  567.         # one short option and one long option, either of which
  568.         # could be None.
  569.         opts = filter(None, opts)
  570.         if not opts:
  571.             raise TypeError("at least one option string must be supplied")
  572.         return opts
  573.  
  574.     def _set_opt_strings(self, opts):
  575.         for opt in opts:
  576.             if len(opt) < 2:
  577.                 raise OptionError(
  578.                     "invalid option string %r: "
  579.                     "must be at least two characters long" % opt, self)
  580.             elif len(opt) == 2:
  581.                 if not (opt[0] == "-" and opt[1] != "-"):
  582.                     raise OptionError(
  583.                         "invalid short option string %r: "
  584.                         "must be of the form -x, (x any non-dash char)" % opt,
  585.                         self)
  586.                 self._short_opts.append(opt)
  587.             else:
  588.                 if not (opt[0:2] == "--" and opt[2] != "-"):
  589.                     raise OptionError(
  590.                         "invalid long option string %r: "
  591.                         "must start with --, followed by non-dash" % opt,
  592.                         self)
  593.                 self._long_opts.append(opt)
  594.  
  595.     def _set_attrs(self, attrs):
  596.         for attr in self.ATTRS:
  597.             if attrs.has_key(attr):
  598.                 setattr(self, attr, attrs[attr])
  599.                 del attrs[attr]
  600.             else:
  601.                 if attr == 'default':
  602.                     setattr(self, attr, NO_DEFAULT)
  603.                 else:
  604.                     setattr(self, attr, None)
  605.         if attrs:
  606.             attrs = attrs.keys()
  607.             attrs.sort()
  608.             raise OptionError(
  609.                 "invalid keyword arguments: %s" % ", ".join(attrs),
  610.                 self)
  611.  
  612.  
  613.     # -- Constructor validation methods --------------------------------
  614.  
  615.     def _check_action(self):
  616.         if self.action is None:
  617.             self.action = "store"
  618.         elif self.action not in self.ACTIONS:
  619.             raise OptionError("invalid action: %r" % self.action, self)
  620.  
  621.     def _check_type(self):
  622.         if self.type is None:
  623.             if self.action in self.ALWAYS_TYPED_ACTIONS:
  624.                 if self.choices is not None:
  625.                     # The "choices" attribute implies "choice" type.
  626.                     self.type = "choice"
  627.                 else:
  628.                     # No type given?  "string" is the most sensible default.
  629.                     self.type = "string"
  630.         else:
  631.             # Allow type objects or builtin type conversion functions
  632.             # (int, str, etc.) as an alternative to their names.  (The
  633.             # complicated check of __builtin__ is only necessary for
  634.             # Python 2.1 and earlier, and is short-circuited by the
  635.             # first check on modern Pythons.)
  636.             import __builtin__
  637.             if ( type(self.type) is types.TypeType or
  638.                  (hasattr(self.type, "__name__") and
  639.                   getattr(__builtin__, self.type.__name__, None) is self.type) ):
  640.                 self.type = self.type.__name__
  641.  
  642.             if self.type == "str":
  643.                 self.type = "string"
  644.  
  645.             if self.type not in self.TYPES:
  646.                 raise OptionError("invalid option type: %r" % self.type, self)
  647.             if self.action not in self.TYPED_ACTIONS:
  648.                 raise OptionError(
  649.                     "must not supply a type for action %r" % self.action, self)
  650.  
  651.     def _check_choice(self):
  652.         if self.type == "choice":
  653.             if self.choices is None:
  654.                 raise OptionError(
  655.                     "must supply a list of choices for type 'choice'", self)
  656.             elif type(self.choices) not in (types.TupleType, types.ListType):
  657.                 raise OptionError(
  658.                     "choices must be a list of strings ('%s' supplied)"
  659.                     % str(type(self.choices)).split("'")[1], self)
  660.         elif self.choices is not None:
  661.             raise OptionError(
  662.                 "must not supply choices for type %r" % self.type, self)
  663.  
  664.     def _check_dest(self):
  665.         # No destination given, and we need one for this action.  The
  666.         # self.type check is for callbacks that take a value.
  667.         takes_value = (self.action in self.STORE_ACTIONS or
  668.                        self.type is not None)
  669.         if self.dest is None and takes_value:
  670.  
  671.             # Glean a destination from the first long option string,
  672.             # or from the first short option string if no long options.
  673.             if self._long_opts:
  674.                 # eg. "--foo-bar" -> "foo_bar"
  675.                 self.dest = self._long_opts[0][2:].replace('-', '_')
  676.             else:
  677.                 self.dest = self._short_opts[0][1]
  678.  
  679.     def _check_const(self):
  680.         if self.action not in self.CONST_ACTIONS and self.const is not None:
  681.             raise OptionError(
  682.                 "'const' must not be supplied for action %r" % self.action,
  683.                 self)
  684.  
  685.     def _check_nargs(self):
  686.         if self.action in self.TYPED_ACTIONS:
  687.             if self.nargs is None:
  688.                 self.nargs = 1
  689.         elif self.nargs is not None:
  690.             raise OptionError(
  691.                 "'nargs' must not be supplied for action %r" % self.action,
  692.                 self)
  693.  
  694.     def _check_callback(self):
  695.         if self.action == "callback":
  696.             if not callable(self.callback):
  697.                 raise OptionError(
  698.                     "callback not callable: %r" % self.callback, self)
  699.             if (self.callback_args is not None and
  700.                 type(self.callback_args) is not types.TupleType):
  701.                 raise OptionError(
  702.                     "callback_args, if supplied, must be a tuple: not %r"
  703.                     % self.callback_args, self)
  704.             if (self.callback_kwargs is not None and
  705.                 type(self.callback_kwargs) is not types.DictType):
  706.                 raise OptionError(
  707.                     "callback_kwargs, if supplied, must be a dict: not %r"
  708.                     % self.callback_kwargs, self)
  709.         else:
  710.             if self.callback is not None:
  711.                 raise OptionError(
  712.                     "callback supplied (%r) for non-callback option"
  713.                     % self.callback, self)
  714.             if self.callback_args is not None:
  715.                 raise OptionError(
  716.                     "callback_args supplied for non-callback option", self)
  717.             if self.callback_kwargs is not None:
  718.                 raise OptionError(
  719.                     "callback_kwargs supplied for non-callback option", self)
  720.  
  721.  
  722.     CHECK_METHODS = [_check_action,
  723.                      _check_type,
  724.                      _check_choice,
  725.                      _check_dest,
  726.                      _check_const,
  727.                      _check_nargs,
  728.                      _check_callback]
  729.  
  730.  
  731.     # -- Miscellaneous methods -----------------------------------------
  732.  
  733.     def __str__(self):
  734.         return "/".join(self._short_opts + self._long_opts)
  735.  
  736.     __repr__ = _repr
  737.  
  738.     def takes_value(self):
  739.         return self.type is not None
  740.  
  741.     def get_opt_string(self):
  742.         if self._long_opts:
  743.             return self._long_opts[0]
  744.         else:
  745.             return self._short_opts[0]
  746.  
  747.  
  748.     # -- Processing methods --------------------------------------------
  749.  
  750.     def check_value(self, opt, value):
  751.         checker = self.TYPE_CHECKER.get(self.type)
  752.         if checker is None:
  753.             return value
  754.         else:
  755.             return checker(self, opt, value)
  756.  
  757.     def convert_value(self, opt, value):
  758.         if value is not None:
  759.             if self.nargs == 1:
  760.                 return self.check_value(opt, value)
  761.             else:
  762.                 return tuple([self.check_value(opt, v) for v in value])
  763.  
  764.     def process(self, opt, value, values, parser):
  765.  
  766.         # First, convert the value(s) to the right type.  Howl if any
  767.         # value(s) are bogus.
  768.         value = self.convert_value(opt, value)
  769.  
  770.         # And then take whatever action is expected of us.
  771.         # This is a separate method to make life easier for
  772.         # subclasses to add new actions.
  773.         return self.take_action(
  774.             self.action, self.dest, opt, value, values, parser)
  775.  
  776.     def take_action(self, action, dest, opt, value, values, parser):
  777.         if action == "store":
  778.             setattr(values, dest, value)
  779.         elif action == "store_const":
  780.             setattr(values, dest, self.const)
  781.         elif action == "store_true":
  782.             setattr(values, dest, True)
  783.         elif action == "store_false":
  784.             setattr(values, dest, False)
  785.         elif action == "append":
  786.             values.ensure_value(dest, []).append(value)
  787.         elif action == "append_const":
  788.             values.ensure_value(dest, []).append(self.const)
  789.         elif action == "count":
  790.             setattr(values, dest, values.ensure_value(dest, 0) + 1)
  791.         elif action == "callback":
  792.             args = self.callback_args or ()
  793.             kwargs = self.callback_kwargs or {}
  794.             self.callback(self, opt, value, parser, *args, **kwargs)
  795.         elif action == "help":
  796.             parser.print_help()
  797.             parser.exit()
  798.         elif action == "version":
  799.             parser.print_version()
  800.             parser.exit()
  801.         else:
  802.             raise RuntimeError, "unknown action %r" % self.action
  803.  
  804.         return 1
  805.  
  806. # class Option
  807.  
  808.  
  809. SUPPRESS_HELP = "SUPPRESS"+"HELP"
  810. SUPPRESS_USAGE = "SUPPRESS"+"USAGE"
  811.  
  812. # For compatibility with Python 2.2
  813. try:
  814.     True, False
  815. except NameError:
  816.     (True, False) = (1, 0)
  817.  
  818. try:
  819.     basestring
  820. except NameError:
  821.     def isbasestring(x):
  822.         return isinstance(x, (types.StringType, types.UnicodeType))
  823. else:
  824.     def isbasestring(x):
  825.         return isinstance(x, basestring)
  826.  
  827.  
  828. class Values:
  829.  
  830.     def __init__(self, defaults=None):
  831.         if defaults:
  832.             for (attr, val) in defaults.items():
  833.                 setattr(self, attr, val)
  834.  
  835.     def __str__(self):
  836.         return str(self.__dict__)
  837.  
  838.     __repr__ = _repr
  839.  
  840.     def __cmp__(self, other):
  841.         if isinstance(other, Values):
  842.             return cmp(self.__dict__, other.__dict__)
  843.         elif isinstance(other, types.DictType):
  844.             return cmp(self.__dict__, other)
  845.         else:
  846.             return -1
  847.  
  848.     def _update_careful(self, dict):
  849.         """
  850.         Update the option values from an arbitrary dictionary, but only
  851.         use keys from dict that already have a corresponding attribute
  852.         in self.  Any keys in dict without a corresponding attribute
  853.         are silently ignored.
  854.         """
  855.         for attr in dir(self):
  856.             if dict.has_key(attr):
  857.                 dval = dict[attr]
  858.                 if dval is not None:
  859.                     setattr(self, attr, dval)
  860.  
  861.     def _update_loose(self, dict):
  862.         """
  863.         Update the option values from an arbitrary dictionary,
  864.         using all keys from the dictionary regardless of whether
  865.         they have a corresponding attribute in self or not.
  866.         """
  867.         self.__dict__.update(dict)
  868.  
  869.     def _update(self, dict, mode):
  870.         if mode == "careful":
  871.             self._update_careful(dict)
  872.         elif mode == "loose":
  873.             self._update_loose(dict)
  874.         else:
  875.             raise ValueError, "invalid update mode: %r" % mode
  876.  
  877.     def read_module(self, modname, mode="careful"):
  878.         __import__(modname)
  879.         mod = sys.modules[modname]
  880.         self._update(vars(mod), mode)
  881.  
  882.     def read_file(self, filename, mode="careful"):
  883.         vars = {}
  884.         execfile(filename, vars)
  885.         self._update(vars, mode)
  886.  
  887.     def ensure_value(self, attr, value):
  888.         if not hasattr(self, attr) or getattr(self, attr) is None:
  889.             setattr(self, attr, value)
  890.         return getattr(self, attr)
  891.  
  892.  
  893. class OptionContainer:
  894.  
  895.     """
  896.     Abstract base class.
  897.  
  898.     Class attributes:
  899.       standard_option_list : [Option]
  900.         list of standard options that will be accepted by all instances
  901.         of this parser class (intended to be overridden by subclasses).
  902.  
  903.     Instance attributes:
  904.       option_list : [Option]
  905.         the list of Option objects contained by this OptionContainer
  906.       _short_opt : { string : Option }
  907.         dictionary mapping short option strings, eg. "-f" or "-X",
  908.         to the Option instances that implement them.  If an Option
  909.         has multiple short option strings, it will appears in this
  910.         dictionary multiple times. [1]
  911.       _long_opt : { string : Option }
  912.         dictionary mapping long option strings, eg. "--file" or
  913.         "--exclude", to the Option instances that implement them.
  914.         Again, a given Option can occur multiple times in this
  915.         dictionary. [1]
  916.       defaults : { string : any }
  917.         dictionary mapping option destination names to default
  918.         values for each destination [1]
  919.  
  920.     [1] These mappings are common to (shared by) all components of the
  921.         controlling OptionParser, where they are initially created.
  922.  
  923.     """
  924.  
  925.     def __init__(self, option_class, conflict_handler, description):
  926.         # Initialize the option list and related data structures.
  927.         # This method must be provided by subclasses, and it must
  928.         # initialize at least the following instance attributes:
  929.         # option_list, _short_opt, _long_opt, defaults.
  930.         self._create_option_list()
  931.  
  932.         self.option_class = option_class
  933.         self.set_conflict_handler(conflict_handler)
  934.         self.set_description(description)
  935.  
  936.     def _create_option_mappings(self):
  937.         # For use by OptionParser constructor -- create the master
  938.         # option mappings used by this OptionParser and all
  939.         # OptionGroups that it owns.
  940.         self._short_opt = {}            # single letter -> Option instance
  941.         self._long_opt = {}             # long option -> Option instance
  942.         self.defaults = {}              # maps option dest -> default value
  943.  
  944.  
  945.     def _share_option_mappings(self, parser):
  946.         # For use by OptionGroup constructor -- use shared option
  947.         # mappings from the OptionParser that owns this OptionGroup.
  948.         self._short_opt = parser._short_opt
  949.         self._long_opt = parser._long_opt
  950.         self.defaults = parser.defaults
  951.  
  952.     def set_conflict_handler(self, handler):
  953.         if handler not in ("error", "resolve"):
  954.             raise ValueError, "invalid conflict_resolution value %r" % handler
  955.         self.conflict_handler = handler
  956.  
  957.     def set_description(self, description):
  958.         self.description = description
  959.  
  960.     def get_description(self):
  961.         return self.description
  962.  
  963.  
  964.     def destroy(self):
  965.         """see OptionParser.destroy()."""
  966.         del self._short_opt
  967.         del self._long_opt
  968.         del self.defaults
  969.  
  970.  
  971.     # -- Option-adding methods -----------------------------------------
  972.  
  973.     def _check_conflict(self, option):
  974.         conflict_opts = []
  975.         for opt in option._short_opts:
  976.             if self._short_opt.has_key(opt):
  977.                 conflict_opts.append((opt, self._short_opt[opt]))
  978.         for opt in option._long_opts:
  979.             if self._long_opt.has_key(opt):
  980.                 conflict_opts.append((opt, self._long_opt[opt]))
  981.  
  982.         if conflict_opts:
  983.             handler = self.conflict_handler
  984.             if handler == "error":
  985.                 raise OptionConflictError(
  986.                     "conflicting option string(s): %s"
  987.                     % ", ".join([co[0] for co in conflict_opts]),
  988.                     option)
  989.             elif handler == "resolve":
  990.                 for (opt, c_option) in conflict_opts:
  991.                     if opt.startswith("--"):
  992.                         c_option._long_opts.remove(opt)
  993.                         del self._long_opt[opt]
  994.                     else:
  995.                         c_option._short_opts.remove(opt)
  996.                         del self._short_opt[opt]
  997.                     if not (c_option._short_opts or c_option._long_opts):
  998.                         c_option.container.option_list.remove(c_option)
  999.  
  1000.     def add_option(self, *args, **kwargs):
  1001.         """add_option(Option)
  1002.            add_option(opt_str, ..., kwarg=val, ...)
  1003.         """
  1004.         if type(args[0]) is types.StringType:
  1005.             option = self.option_class(*args, **kwargs)
  1006.         elif len(args) == 1 and not kwargs:
  1007.             option = args[0]
  1008.             if not isinstance(option, Option):
  1009.                 raise TypeError, "not an Option instance: %r" % option
  1010.         else:
  1011.             raise TypeError, "invalid arguments"
  1012.  
  1013.         self._check_conflict(option)
  1014.  
  1015.         self.option_list.append(option)
  1016.         option.container = self
  1017.         for opt in option._short_opts:
  1018.             self._short_opt[opt] = option
  1019.         for opt in option._long_opts:
  1020.             self._long_opt[opt] = option
  1021.  
  1022.         if option.dest is not None:     # option has a dest, we need a default
  1023.             if option.default is not NO_DEFAULT:
  1024.                 self.defaults[option.dest] = option.default
  1025.             elif not self.defaults.has_key(option.dest):
  1026.                 self.defaults[option.dest] = None
  1027.  
  1028.         return option
  1029.  
  1030.     def add_options(self, option_list):
  1031.         for option in option_list:
  1032.             self.add_option(option)
  1033.  
  1034.     # -- Option query/removal methods ----------------------------------
  1035.  
  1036.     def get_option(self, opt_str):
  1037.         return (self._short_opt.get(opt_str) or
  1038.                 self._long_opt.get(opt_str))
  1039.  
  1040.     def has_option(self, opt_str):
  1041.         return (self._short_opt.has_key(opt_str) or
  1042.                 self._long_opt.has_key(opt_str))
  1043.  
  1044.     def remove_option(self, opt_str):
  1045.         option = self._short_opt.get(opt_str)
  1046.         if option is None:
  1047.             option = self._long_opt.get(opt_str)
  1048.         if option is None:
  1049.             raise ValueError("no such option %r" % opt_str)
  1050.  
  1051.         for opt in option._short_opts:
  1052.             del self._short_opt[opt]
  1053.         for opt in option._long_opts:
  1054.             del self._long_opt[opt]
  1055.         option.container.option_list.remove(option)
  1056.  
  1057.  
  1058.     # -- Help-formatting methods ---------------------------------------
  1059.  
  1060.     def format_option_help(self, formatter):
  1061.         if not self.option_list:
  1062.             return ""
  1063.         result = []
  1064.         for option in self.option_list:
  1065.             if not option.help is SUPPRESS_HELP:
  1066.                 result.append(formatter.format_option(option))
  1067.         return "".join(result)
  1068.  
  1069.     def format_description(self, formatter):
  1070.         return formatter.format_description(self.get_description())
  1071.  
  1072.     def format_help(self, formatter):
  1073.         result = []
  1074.         if self.description:
  1075.             result.append(self.format_description(formatter))
  1076.         if self.option_list:
  1077.             result.append(self.format_option_help(formatter))
  1078.         return "\n".join(result)
  1079.  
  1080.  
  1081. class OptionGroup (OptionContainer):
  1082.  
  1083.     def __init__(self, parser, title, description=None):
  1084.         self.parser = parser
  1085.         OptionContainer.__init__(
  1086.             self, parser.option_class, parser.conflict_handler, description)
  1087.         self.title = title
  1088.  
  1089.     def _create_option_list(self):
  1090.         self.option_list = []
  1091.         self._share_option_mappings(self.parser)
  1092.  
  1093.     def set_title(self, title):
  1094.         self.title = title
  1095.  
  1096.     def destroy(self):
  1097.         """see OptionParser.destroy()."""
  1098.         OptionContainer.destroy(self)
  1099.         del self.option_list
  1100.  
  1101.     # -- Help-formatting methods ---------------------------------------
  1102.  
  1103.     def format_help(self, formatter):
  1104.         result = formatter.format_heading(self.title)
  1105.         formatter.indent()
  1106.         result += OptionContainer.format_help(self, formatter)
  1107.         formatter.dedent()
  1108.         return result
  1109.  
  1110.  
  1111. class OptionParser (OptionContainer):
  1112.  
  1113.     """
  1114.     Class attributes:
  1115.       standard_option_list : [Option]
  1116.         list of standard options that will be accepted by all instances
  1117.         of this parser class (intended to be overridden by subclasses).
  1118.  
  1119.     Instance attributes:
  1120.       usage : string
  1121.         a usage string for your program.  Before it is displayed
  1122.         to the user, "%prog" will be expanded to the name of
  1123.         your program (self.prog or os.path.basename(sys.argv[0])).
  1124.       prog : string
  1125.         the name of the current program (to override
  1126.         os.path.basename(sys.argv[0])).
  1127.       epilog : string
  1128.         paragraph of help text to print after option help
  1129.  
  1130.       option_groups : [OptionGroup]
  1131.         list of option groups in this parser (option groups are
  1132.         irrelevant for parsing the command-line, but very useful
  1133.         for generating help)
  1134.  
  1135.       allow_interspersed_args : bool = true
  1136.         if true, positional arguments may be interspersed with options.
  1137.         Assuming -a and -b each take a single argument, the command-line
  1138.           -ablah foo bar -bboo baz
  1139.         will be interpreted the same as
  1140.           -ablah -bboo -- foo bar baz
  1141.         If this flag were false, that command line would be interpreted as
  1142.           -ablah -- foo bar -bboo baz
  1143.         -- ie. we stop processing options as soon as we see the first
  1144.         non-option argument.  (This is the tradition followed by
  1145.         Python's getopt module, Perl's Getopt::Std, and other argument-
  1146.         parsing libraries, but it is generally annoying to users.)
  1147.  
  1148.       process_default_values : bool = true
  1149.         if true, option default values are processed similarly to option
  1150.         values from the command line: that is, they are passed to the
  1151.         type-checking function for the option's type (as long as the
  1152.         default value is a string).  (This really only matters if you
  1153.         have defined custom types; see SF bug #955889.)  Set it to false
  1154.         to restore the behaviour of Optik 1.4.1 and earlier.
  1155.  
  1156.       rargs : [string]
  1157.         the argument list currently being parsed.  Only set when
  1158.         parse_args() is active, and continually trimmed down as
  1159.         we consume arguments.  Mainly there for the benefit of
  1160.         callback options.
  1161.       largs : [string]
  1162.         the list of leftover arguments that we have skipped while
  1163.         parsing options.  If allow_interspersed_args is false, this
  1164.         list is always empty.
  1165.       values : Values
  1166.         the set of option values currently being accumulated.  Only
  1167.         set when parse_args() is active.  Also mainly for callbacks.
  1168.  
  1169.     Because of the 'rargs', 'largs', and 'values' attributes,
  1170.     OptionParser is not thread-safe.  If, for some perverse reason, you
  1171.     need to parse command-line arguments simultaneously in different
  1172.     threads, use different OptionParser instances.
  1173.  
  1174.     """
  1175.  
  1176.     standard_option_list = []
  1177.  
  1178.     def __init__(self,
  1179.                  usage=None,
  1180.                  option_list=None,
  1181.                  option_class=Option,
  1182.                  version=None,
  1183.                  conflict_handler="error",
  1184.                  description=None,
  1185.                  formatter=None,
  1186.                  add_help_option=True,
  1187.                  prog=None,
  1188.                  epilog=None):
  1189.         OptionContainer.__init__(
  1190.             self, option_class, conflict_handler, description)
  1191.         self.set_usage(usage)
  1192.         self.prog = prog
  1193.         self.version = version
  1194.         self.allow_interspersed_args = True
  1195.         self.process_default_values = True
  1196.         if formatter is None:
  1197.             formatter = IndentedHelpFormatter()
  1198.         self.formatter = formatter
  1199.         self.formatter.set_parser(self)
  1200.         self.epilog = epilog
  1201.  
  1202.         # Populate the option list; initial sources are the
  1203.         # standard_option_list class attribute, the 'option_list'
  1204.         # argument, and (if applicable) the _add_version_option() and
  1205.         # _add_help_option() methods.
  1206.         self._populate_option_list(option_list,
  1207.                                    add_help=add_help_option)
  1208.  
  1209.         self._init_parsing_state()
  1210.  
  1211.  
  1212.     def destroy(self):
  1213.         """
  1214.         Declare that you are done with this OptionParser.  This cleans up
  1215.         reference cycles so the OptionParser (and all objects referenced by
  1216.         it) can be garbage-collected promptly.  After calling destroy(), the
  1217.         OptionParser is unusable.
  1218.         """
  1219.         OptionContainer.destroy(self)
  1220.         for group in self.option_groups:
  1221.             group.destroy()
  1222.         del self.option_list
  1223.         del self.option_groups
  1224.         del self.formatter
  1225.  
  1226.  
  1227.     # -- Private methods -----------------------------------------------
  1228.     # (used by our or OptionContainer's constructor)
  1229.  
  1230.     def _create_option_list(self):
  1231.         self.option_list = []
  1232.         self.option_groups = []
  1233.         self._create_option_mappings()
  1234.  
  1235.     def _add_help_option(self):
  1236.         self.add_option("-h", "--help",
  1237.                         action="help",
  1238.                         help=_("show this help message and exit"))
  1239.  
  1240.     def _add_version_option(self):
  1241.         self.add_option("--version",
  1242.                         action="version",
  1243.                         help=_("show program's version number and exit"))
  1244.  
  1245.     def _populate_option_list(self, option_list, add_help=True):
  1246.         if self.standard_option_list:
  1247.             self.add_options(self.standard_option_list)
  1248.         if option_list:
  1249.             self.add_options(option_list)
  1250.         if self.version:
  1251.             self._add_version_option()
  1252.         if add_help:
  1253.             self._add_help_option()
  1254.  
  1255.     def _init_parsing_state(self):
  1256.         # These are set in parse_args() for the convenience of callbacks.
  1257.         self.rargs = None
  1258.         self.largs = None
  1259.         self.values = None
  1260.  
  1261.  
  1262.     # -- Simple modifier methods ---------------------------------------
  1263.  
  1264.     def set_usage(self, usage):
  1265.         if usage is None:
  1266.             self.usage = _("%prog [options]")
  1267.         elif usage is SUPPRESS_USAGE:
  1268.             self.usage = None
  1269.         # For backwards compatibility with Optik 1.3 and earlier.
  1270.         elif usage.lower().startswith("usage: "):
  1271.             self.usage = usage[7:]
  1272.         else:
  1273.             self.usage = usage
  1274.  
  1275.     def enable_interspersed_args(self):
  1276.         """Set parsing to not stop on the first non-option, allowing
  1277.         interspersing switches with command arguments. This is the
  1278.         default behavior. See also disable_interspersed_args() and the
  1279.         class documentation description of the attribute
  1280.         allow_interspersed_args."""
  1281.         self.allow_interspersed_args = True
  1282.  
  1283.     def disable_interspersed_args(self):
  1284.         """Set parsing to stop on the first non-option. Use this if
  1285.         you have a command processor which runs another command that
  1286.         has options of its own and you want to make sure these options
  1287.         don't get confused.
  1288.         """
  1289.         self.allow_interspersed_args = False
  1290.  
  1291.     def set_process_default_values(self, process):
  1292.         self.process_default_values = process
  1293.  
  1294.     def set_default(self, dest, value):
  1295.         self.defaults[dest] = value
  1296.  
  1297.     def set_defaults(self, **kwargs):
  1298.         self.defaults.update(kwargs)
  1299.  
  1300.     def _get_all_options(self):
  1301.         options = self.option_list[:]
  1302.         for group in self.option_groups:
  1303.             options.extend(group.option_list)
  1304.         return options
  1305.  
  1306.     def get_default_values(self):
  1307.         if not self.process_default_values:
  1308.             # Old, pre-Optik 1.5 behaviour.
  1309.             return Values(self.defaults)
  1310.  
  1311.         defaults = self.defaults.copy()
  1312.         for option in self._get_all_options():
  1313.             default = defaults.get(option.dest)
  1314.             if isbasestring(default):
  1315.                 opt_str = option.get_opt_string()
  1316.                 defaults[option.dest] = option.check_value(opt_str, default)
  1317.  
  1318.         return Values(defaults)
  1319.  
  1320.  
  1321.     # -- OptionGroup methods -------------------------------------------
  1322.  
  1323.     def add_option_group(self, *args, **kwargs):
  1324.         # XXX lots of overlap with OptionContainer.add_option()
  1325.         if type(args[0]) is types.StringType:
  1326.             group = OptionGroup(self, *args, **kwargs)
  1327.         elif len(args) == 1 and not kwargs:
  1328.             group = args[0]
  1329.             if not isinstance(group, OptionGroup):
  1330.                 raise TypeError, "not an OptionGroup instance: %r" % group
  1331.             if group.parser is not self:
  1332.                 raise ValueError, "invalid OptionGroup (wrong parser)"
  1333.         else:
  1334.             raise TypeError, "invalid arguments"
  1335.  
  1336.         self.option_groups.append(group)
  1337.         return group
  1338.  
  1339.     def get_option_group(self, opt_str):
  1340.         option = (self._short_opt.get(opt_str) or
  1341.                   self._long_opt.get(opt_str))
  1342.         if option and option.container is not self:
  1343.             return option.container
  1344.         return None
  1345.  
  1346.  
  1347.     # -- Option-parsing methods ----------------------------------------
  1348.  
  1349.     def _get_args(self, args):
  1350.         if args is None:
  1351.             return sys.argv[1:]
  1352.         else:
  1353.             return args[:]              # don't modify caller's list
  1354.  
  1355.     def parse_args(self, args=None, values=None):
  1356.         """
  1357.         parse_args(args : [string] = sys.argv[1:],
  1358.                    values : Values = None)
  1359.         -> (values : Values, args : [string])
  1360.  
  1361.         Parse the command-line options found in 'args' (default:
  1362.         sys.argv[1:]).  Any errors result in a call to 'error()', which
  1363.         by default prints the usage message to stderr and calls
  1364.         sys.exit() with an error message.  On success returns a pair
  1365.         (values, args) where 'values' is an Values instance (with all
  1366.         your option values) and 'args' is the list of arguments left
  1367.         over after parsing options.
  1368.         """
  1369.         rargs = self._get_args(args)
  1370.         if values is None:
  1371.             values = self.get_default_values()
  1372.  
  1373.         # Store the halves of the argument list as attributes for the
  1374.         # convenience of callbacks:
  1375.         #   rargs
  1376.         #     the rest of the command-line (the "r" stands for
  1377.         #     "remaining" or "right-hand")
  1378.         #   largs
  1379.         #     the leftover arguments -- ie. what's left after removing
  1380.         #     options and their arguments (the "l" stands for "leftover"
  1381.         #     or "left-hand")
  1382.         self.rargs = rargs
  1383.         self.largs = largs = []
  1384.         self.values = values
  1385.  
  1386.         try:
  1387.             stop = self._process_args(largs, rargs, values)
  1388.         except (BadOptionError, OptionValueError), err:
  1389.             self.error(str(err))
  1390.  
  1391.         args = largs + rargs
  1392.         return self.check_values(values, args)
  1393.  
  1394.     def check_values(self, values, args):
  1395.         """
  1396.         check_values(values : Values, args : [string])
  1397.         -> (values : Values, args : [string])
  1398.  
  1399.         Check that the supplied option values and leftover arguments are
  1400.         valid.  Returns the option values and leftover arguments
  1401.         (possibly adjusted, possibly completely new -- whatever you
  1402.         like).  Default implementation just returns the passed-in
  1403.         values; subclasses may override as desired.
  1404.         """
  1405.         return (values, args)
  1406.  
  1407.     def _process_args(self, largs, rargs, values):
  1408.         """_process_args(largs : [string],
  1409.                          rargs : [string],
  1410.                          values : Values)
  1411.  
  1412.         Process command-line arguments and populate 'values', consuming
  1413.         options and arguments from 'rargs'.  If 'allow_interspersed_args' is
  1414.         false, stop at the first non-option argument.  If true, accumulate any
  1415.         interspersed non-option arguments in 'largs'.
  1416.         """
  1417.         while rargs:
  1418.             arg = rargs[0]
  1419.             # We handle bare "--" explicitly, and bare "-" is handled by the
  1420.             # standard arg handler since the short arg case ensures that the
  1421.             # len of the opt string is greater than 1.
  1422.             if arg == "--":
  1423.                 del rargs[0]
  1424.                 return
  1425.             elif arg[0:2] == "--":
  1426.                 # process a single long option (possibly with value(s))
  1427.                 self._process_long_opt(rargs, values)
  1428.             elif arg[:1] == "-" and len(arg) > 1:
  1429.                 # process a cluster of short options (possibly with
  1430.                 # value(s) for the last one only)
  1431.                 self._process_short_opts(rargs, values)
  1432.             elif self.allow_interspersed_args:
  1433.                 largs.append(arg)
  1434.                 del rargs[0]
  1435.             else:
  1436.                 return                  # stop now, leave this arg in rargs
  1437.  
  1438.         # Say this is the original argument list:
  1439.         # [arg0, arg1, ..., arg(i-1), arg(i), arg(i+1), ..., arg(N-1)]
  1440.         #                            ^
  1441.         # (we are about to process arg(i)).
  1442.         #
  1443.         # Then rargs is [arg(i), ..., arg(N-1)] and largs is a *subset* of
  1444.         # [arg0, ..., arg(i-1)] (any options and their arguments will have
  1445.         # been removed from largs).
  1446.         #
  1447.         # The while loop will usually consume 1 or more arguments per pass.
  1448.         # If it consumes 1 (eg. arg is an option that takes no arguments),
  1449.         # then after _process_arg() is done the situation is:
  1450.         #
  1451.         #   largs = subset of [arg0, ..., arg(i)]
  1452.         #   rargs = [arg(i+1), ..., arg(N-1)]
  1453.         #
  1454.         # If allow_interspersed_args is false, largs will always be
  1455.         # *empty* -- still a subset of [arg0, ..., arg(i-1)], but
  1456.         # not a very interesting subset!
  1457.  
  1458.     def _match_long_opt(self, opt):
  1459.         """_match_long_opt(opt : string) -> string
  1460.  
  1461.         Determine which long option string 'opt' matches, ie. which one
  1462.         it is an unambiguous abbrevation for.  Raises BadOptionError if
  1463.         'opt' doesn't unambiguously match any long option string.
  1464.         """
  1465.         return _match_abbrev(opt, self._long_opt)
  1466.  
  1467.     def _process_long_opt(self, rargs, values):
  1468.         arg = rargs.pop(0)
  1469.  
  1470.         # Value explicitly attached to arg?  Pretend it's the next
  1471.         # argument.
  1472.         if "=" in arg:
  1473.             (opt, next_arg) = arg.split("=", 1)
  1474.             rargs.insert(0, next_arg)
  1475.             had_explicit_value = True
  1476.         else:
  1477.             opt = arg
  1478.             had_explicit_value = False
  1479.  
  1480.         opt = self._match_long_opt(opt)
  1481.         option = self._long_opt[opt]
  1482.         if option.takes_value():
  1483.             nargs = option.nargs
  1484.             if len(rargs) < nargs:
  1485.                 if nargs == 1:
  1486.                     self.error(_("%s option requires an argument") % opt)
  1487.                 else:
  1488.                     self.error(_("%s option requires %d arguments")
  1489.                                % (opt, nargs))
  1490.             elif nargs == 1:
  1491.                 value = rargs.pop(0)
  1492.             else:
  1493.                 value = tuple(rargs[0:nargs])
  1494.                 del rargs[0:nargs]
  1495.  
  1496.         elif had_explicit_value:
  1497.             self.error(_("%s option does not take a value") % opt)
  1498.  
  1499.         else:
  1500.             value = None
  1501.  
  1502.         option.process(opt, value, values, self)
  1503.  
  1504.     def _process_short_opts(self, rargs, values):
  1505.         arg = rargs.pop(0)
  1506.         stop = False
  1507.         i = 1
  1508.         for ch in arg[1:]:
  1509.             opt = "-" + ch
  1510.             option = self._short_opt.get(opt)
  1511.             i += 1                      # we have consumed a character
  1512.  
  1513.             if not option:
  1514.                 raise BadOptionError(opt)
  1515.             if option.takes_value():
  1516.                 # Any characters left in arg?  Pretend they're the
  1517.                 # next arg, and stop consuming characters of arg.
  1518.                 if i < len(arg):
  1519.                     rargs.insert(0, arg[i:])
  1520.                     stop = True
  1521.  
  1522.                 nargs = option.nargs
  1523.                 if len(rargs) < nargs:
  1524.                     if nargs == 1:
  1525.                         self.error(_("%s option requires an argument") % opt)
  1526.                     else:
  1527.                         self.error(_("%s option requires %d arguments")
  1528.                                    % (opt, nargs))
  1529.                 elif nargs == 1:
  1530.                     value = rargs.pop(0)
  1531.                 else:
  1532.                     value = tuple(rargs[0:nargs])
  1533.                     del rargs[0:nargs]
  1534.  
  1535.             else:                       # option doesn't take a value
  1536.                 value = None
  1537.  
  1538.             option.process(opt, value, values, self)
  1539.  
  1540.             if stop:
  1541.                 break
  1542.  
  1543.  
  1544.     # -- Feedback methods ----------------------------------------------
  1545.  
  1546.     def get_prog_name(self):
  1547.         if self.prog is None:
  1548.             return os.path.basename(sys.argv[0])
  1549.         else:
  1550.             return self.prog
  1551.  
  1552.     def expand_prog_name(self, s):
  1553.         return s.replace("%prog", self.get_prog_name())
  1554.  
  1555.     def get_description(self):
  1556.         return self.expand_prog_name(self.description)
  1557.  
  1558.     def exit(self, status=0, msg=None):
  1559.         if msg:
  1560.             sys.stderr.write(msg)
  1561.         sys.exit(status)
  1562.  
  1563.     def error(self, msg):
  1564.         """error(msg : string)
  1565.  
  1566.         Print a usage message incorporating 'msg' to stderr and exit.
  1567.         If you override this in a subclass, it should not return -- it
  1568.         should either exit or raise an exception.
  1569.         """
  1570.         self.print_usage(sys.stderr)
  1571.         self.exit(2, "%s: error: %s\n" % (self.get_prog_name(), msg))
  1572.  
  1573.     def get_usage(self):
  1574.         if self.usage:
  1575.             return self.formatter.format_usage(
  1576.                 self.expand_prog_name(self.usage))
  1577.         else:
  1578.             return ""
  1579.  
  1580.     def print_usage(self, file=None):
  1581.         """print_usage(file : file = stdout)
  1582.  
  1583.         Print the usage message for the current program (self.usage) to
  1584.         'file' (default stdout).  Any occurence of the string "%prog" in
  1585.         self.usage is replaced with the name of the current program
  1586.         (basename of sys.argv[0]).  Does nothing if self.usage is empty
  1587.         or not defined.
  1588.         """
  1589.         if self.usage:
  1590.             print >>file, self.get_usage()
  1591.  
  1592.     def get_version(self):
  1593.         if self.version:
  1594.             return self.expand_prog_name(self.version)
  1595.         else:
  1596.             return ""
  1597.  
  1598.     def print_version(self, file=None):
  1599.         """print_version(file : file = stdout)
  1600.  
  1601.         Print the version message for this program (self.version) to
  1602.         'file' (default stdout).  As with print_usage(), any occurence
  1603.         of "%prog" in self.version is replaced by the current program's
  1604.         name.  Does nothing if self.version is empty or undefined.
  1605.         """
  1606.         if self.version:
  1607.             print >>file, self.get_version()
  1608.  
  1609.     def format_option_help(self, formatter=None):
  1610.         if formatter is None:
  1611.             formatter = self.formatter
  1612.         formatter.store_option_strings(self)
  1613.         result = []
  1614.         result.append(formatter.format_heading(_("Options")))
  1615.         formatter.indent()
  1616.         if self.option_list:
  1617.             result.append(OptionContainer.format_option_help(self, formatter))
  1618.             result.append("\n")
  1619.         for group in self.option_groups:
  1620.             result.append(group.format_help(formatter))
  1621.             result.append("\n")
  1622.         formatter.dedent()
  1623.         # Drop the last "\n", or the header if no options or option groups:
  1624.         return "".join(result[:-1])
  1625.  
  1626.     def format_epilog(self, formatter):
  1627.         return formatter.format_epilog(self.epilog)
  1628.  
  1629.     def format_help(self, formatter=None):
  1630.         if formatter is None:
  1631.             formatter = self.formatter
  1632.         result = []
  1633.         if self.usage:
  1634.             result.append(self.get_usage() + "\n")
  1635.         if self.description:
  1636.             result.append(self.format_description(formatter) + "\n")
  1637.         result.append(self.format_option_help(formatter))
  1638.         result.append(self.format_epilog(formatter))
  1639.         return "".join(result)
  1640.  
  1641.     # used by test suite
  1642.     def _get_encoding(self, file):
  1643.         encoding = getattr(file, "encoding", None)
  1644.         if not encoding:
  1645.             encoding = sys.getdefaultencoding()
  1646.         return encoding
  1647.  
  1648.     def print_help(self, file=None):
  1649.         """print_help(file : file = stdout)
  1650.  
  1651.         Print an extended help message, listing all options and any
  1652.         help text provided with them, to 'file' (default stdout).
  1653.         """
  1654.         if file is None:
  1655.             file = sys.stdout
  1656.         encoding = self._get_encoding(file)
  1657.         file.write(self.format_help().encode(encoding, "replace"))
  1658.  
  1659. # class OptionParser
  1660.  
  1661.  
  1662. def _match_abbrev(s, wordmap):
  1663.     """_match_abbrev(s : string, wordmap : {string : Option}) -> string
  1664.  
  1665.     Return the string key in 'wordmap' for which 's' is an unambiguous
  1666.     abbreviation.  If 's' is found to be ambiguous or doesn't match any of
  1667.     'words', raise BadOptionError.
  1668.     """
  1669.     # Is there an exact match?
  1670.     if wordmap.has_key(s):
  1671.         return s
  1672.     else:
  1673.         # Isolate all words with s as a prefix.
  1674.         possibilities = [word for word in wordmap.keys()
  1675.                          if word.startswith(s)]
  1676.         # No exact match, so there had better be just one possibility.
  1677.         if len(possibilities) == 1:
  1678.             return possibilities[0]
  1679.         elif not possibilities:
  1680.             raise BadOptionError(s)
  1681.         else:
  1682.             # More than one possible completion: ambiguous prefix.
  1683.             possibilities.sort()
  1684.             raise AmbiguousOptionError(s, possibilities)
  1685.  
  1686.  
  1687. # Some day, there might be many Option classes.  As of Optik 1.3, the
  1688. # preferred way to instantiate Options is indirectly, via make_option(),
  1689. # which will become a factory function when there are many Option
  1690. # classes.
  1691. make_option = Option
  1692.